/*
 *
 *  * Copyright 2015 Skymind,Inc.
 *  *
 *  *    Licensed under the Apache License, Version 2.0 (the "License");
 *  *    you may not use this file except in compliance with the License.
 *  *    You may obtain a copy of the License at
 *  *
 *  *        http://www.apache.org/licenses/LICENSE-2.0
 *  *
 *  *    Unless required by applicable law or agreed to in writing, software
 *  *    distributed under the License is distributed on an "AS IS" BASIS,
 *  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  *    See the License for the specific language governing permissions and
 *  *    limitations under the License.
 *
 */

package org.deeplearning4j.text.sentenceiterator.labelaware;

import org.deeplearning4j.text.sentenceiterator.SentenceIterator;

import java.util.List;

/**
 * SentenceIterator that is aware of its label. This is useful
 * for creating datasets all at once or on the fly.
 *
 * @author Adam Gibson
 */
public interface LabelAwareSentenceIterator extends SentenceIterator {
    /**
     * Returns the current label for nextSentence()
     * @return the label for nextSentence()
     */
    String currentLabel();


    /**
     * For multi label problems
     * @return
     */
    List<String> currentLabels();

}
